/*
 *       Copyright (c) 2008-2009 All rights reserved
 *               Asemantics S.r.l
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by
 *        Asemantics S.r.l."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *    This product includes software developed by Asemantics S.r.l.
 *    the Semantic Web company, Rome, London, Leiden and its contributors.
 *
 * 5. Neither the name of the company nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */
package com.asemantics.poco.persistence;

import com.asemantics.poco.Entry;
import com.asemantics.poco.query.Query;

import java.util.List;

/**
 * Defines a manager to handle the persistence of core entitities.
 *
 * @author Michele Mostarda ( michele.mostarda@gmail.com )
 * @version $Id: $
 */
public interface Persistor {

     /**
     * Returns the identifier of a given object.
     *
     * @param obj
     * @return storage identifier.
     */
    <T,I> I getIdentifier(T obj);

    /**
     * Persists an object in the storage.
     *
     * @param object
     * @return
     * @throws PersistorException
     */
    <T,I> I persist(T object) throws PersistorException;

    /**
     * Retrieves all objects in the storage of a given type.
     *
     * @param clazz class of objects to be retrieved.
     * @param detach if <code>true</code>, the retrieved object are no more in touch with the store.
     * @return list of retrieved objects.
     * @throws PersistorException if any exception occurs.
     */
    <T> List<T> retrieveAll(Class<T> clazz, boolean detach) throws PersistorException;

    /**
     *  Retrieves all objects in the storage of a given type detaching them.
     *
     * @param clazz class of objects to be retrieved.
     * @return list of retrieved objects.
     * @throws PersistorException
     */
    <T> List<T> retrieveAll(Class<T> clazz) throws PersistorException;

    /**
     * Retrieve an object with given identifier.
     *
     * @param identifier the object identifier.
     * @return the object found.
     * @throws PersistorException
     */
    <T,I> T retrieve(I identifier) throws PersistorException;

    /**
     * Deletes an object by identifier.
     *
     * @param identifier the object identifier.
     * @throws PersistorException if no object with given identifier exists.
     */
    <T,I> void delete(I identifier) throws PersistorException;

    /**
     * Retrieves an entry from the data store respecting the given query creteria.
     *
     * @param userID the used id of the entry to retrieve.
     * @param query query to be applied.
     * @param detach if the result entries must be detached from the persistor.
     * @return list of matching entries.
     * @throws PersistorException if an error occurs during data retrieval.
     */
    List<Entry> retrieveEntry(String userID, Query query, boolean detach)
    throws PersistorException;

    /**
     * Retrieves a list of entries from the data store respecting the given query creteria.
     *
     * @param query query to be applied.
     * @param detach if the result entries must be detached from the persistor.
     * @return list of matching entries.
     * @throws PersistorException if an error occurs during data retrieval.
     */
    List<Entry> retrieveEntries(Query query, boolean detach)
    throws PersistorException;

    /**
     * Retrieves a list of entries from the data store that are connected to an entry specified by userID.
     *
     * @param userID
     * @param query
     * @param detach
     * @return
     * @throws PersistorException
     */
    List<Entry> retrieveEntriesOf(String userID, Query query, boolean detach)
    throws PersistorException;

    /**
     * Opens / reopens the persistor connection.
     */
    void open();

    /**
     * Closes the persistor connection.
     */
    void close();
}
